home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 12 / Cream of the Crop 12 (Part II) / Cream of the Crop 12 (Part II).iso / OS2 / CLNDSK10.ZIP / CLEANDSK.DOC < prev    next >
Encoding:
Text File  |  1996-04-03  |  4.1 KB  |  104 lines
  1.                      CLEANDSK v1.0 Documentation
  2.                      (c) 1996 William D. Ezell
  3.  
  4.  
  5. Overview
  6. ----------
  7.  
  8. CLEANDSK is a simple utility to remove certain commonly-occurring files
  9. from a specified disk or directory tree.  The current version has only
  10. one command-line parameter, that being the starting drive and/or path,
  11. and that parameter is optional.  If omitted CLEANDSK will begin cleaning
  12. in the root directory of drive C: (if it exists) and include all subordinate
  13. directories.
  14.  
  15. CLEANDSK version 1.0 was developed under OS/2 Warp using emx 0.9a.  Full 
  16. C source is included in accordance with the provisions of the GNU licensing 
  17. agreements.  emxbind was used to produce a fully self-contained executable
  18. that will run under both OS/2 and DOS.  The program has been tested under
  19. Warp and MS-DOS 6.22.  Although the program is a nice companion to Windows 3.x
  20. (cleaning up the clutter left by those frequent GPF's) it will must be run
  21. from a real DOS prompt, not from within Windows itself.  CLEANDSK has not
  22. been tested with Windows95 although it MAY work (see disclaimer below).
  23.  
  24. When running CLEANDSK, please read fully the warning prompt displayed.  ALL
  25. files matching the displayed pattern masks WILL BE DELETED, even if they
  26. are flagged read-only.  Currently only files are removed -- directories
  27. matching the pattern masks (e.g., C:\WINDOWS.OLD) are ignored.
  28.  
  29.  
  30. Usage Syntax
  31. ------------
  32.  
  33. There are currently only two usage syntaxes:
  34.  
  35.    CLEANDSK                (no parameters; default action is to process C:\)
  36.  
  37.    CLEANDSK d:\path        process specified drive beginning at specified
  38.                            point in the directory tree.
  39.  
  40.                            Note:  the UNIX-style path separator "/" is also
  41.                            recognized in path specifications.
  42.  
  43.  
  44. Examples
  45. -----------
  46.  
  47.    CLEANDSK c:\windows     removes all matching files on drive C: ONLY in
  48.                            the \windows subdirectory and subordinate dirs
  49.  
  50.    CLEANDSK c:/windows     exactly the same result as above
  51.  
  52.    CLEANDSK d:\            removes all matching files in all directories of
  53.                            drive D:.  Either "\" or "/" MUST be included
  54.                            (e.g., CLEANDSK d: alone will return an error)
  55.  
  56.  
  57. Targeted File Patterns
  58. -----------------------
  59.  
  60. CLEANDSK fully supports both FAT and HPFS naming rules and will target 
  61. ANY file regardless of the naming scheme as long as it matches one or more of
  62. the following patterns:
  63.  
  64.    *.old    *.tmp    *.syd    *.fix    *.chk    *.??_    *.~??    ~*.*
  65.  
  66.  
  67.  
  68. Licensing / Costs / Etc...
  69. --------------------------
  70.  
  71. CLEANDSK is free for private or corporate use in accordance with the provisions
  72. of the GNU General License Agreement.  The executable may not be distributed
  73. without the accompanying source code and this disclaimer.  CLEANDSK was written
  74. by the author to meet a specific need.  Although it has been tested within the
  75. parameters of that need the author assumes no responsibility for its use or
  76. misuse.  The program was designed to delete files and performs that task very
  77. well.  USE IT AT YOUR OWN RISK!  If you are unsure about compatibility with
  78. your system proceed with caution!  Make sure you have a reliable backup before
  79. you test it.
  80.  
  81. As stated above there is no cost for this software.  I would like to know,
  82. however, just where this prgram winds up once it's tossed out onto the
  83. Internet.  If you care to take the time just send me a simple message to either
  84. address listed below.  I assure you your name will be kept in confidence and
  85. no solicitation will be made of you.
  86.  
  87.  
  88.  
  89. The Future
  90. -------------
  91.  
  92. This program represented my first programming attempt using the emx development
  93. system.  Several enhancements are planned, including selectable pattern masks
  94. and an "information-only" mode.  If you have suggestions of features you'd like
  95. to see I'd welcome the input.  I hope you find the program a useful addition to
  96. your tool box.
  97.  
  98.  
  99.                                     William D. Ezell
  100.                                     98 Reese St., Enterprise, AL 36330-1872
  101.                                     wdezell@ibm.net
  102.  
  103.  
  104.